home *** CD-ROM | disk | FTP | other *** search
/ Precision Software Appli…tions Silver Collection 4 / Precision Software Applications Silver Collection Volume 4 (1993).iso / database / flexbase.exe / CHAP7.TXT < prev    next >
Text File  |  1987-07-11  |  24KB  |  313 lines

  1. REPORT GENERATION SYSTEM                                                   
  2.                                                                            
  3.     The Flexbase Report Generation System (RGS) is designed with a 66 line 
  4. by 132 column report design area.  This area can be used to layout a wide  
  5. variety of report types that include columnar, page, labels and invoices.  
  6.                                                                            
  7.                                                                            
  8.                                                                            
  9. HELP                                                                       
  10.                                                                            
  11.     Help has been assigned to the F1 function key.  Pressing this function 
  12. key will open a help window associated with the command or function that   
  13. you are using.                                                             
  14.                                                                            
  15.                                                                            
  16.                                                                            
  17. ROW TYPE IDENTIFIER                                                        
  18.                                                                            
  19. A row type identifier is a label that must be assigned to each row in the  
  20. report that you want to be printed.  The different types of row type       
  21. identifiers allow you to design both simple and complex reports with ease. 
  22.                                                                            
  23. Only those rows in the report design area that have been given a row type  
  24. identifier will be utilized when the report is printed to the specified    
  25. output device.                                                             
  26.                                                                            
  27.     Row type identifiers are set by moving the small block cursor to the   
  28. desired row and then pressing the F3 function key.  This will highlight    
  29. the current row and open a window from which you can select the desired    
  30. row type identifier.  The six possible row types are:                      
  31.                                                                            
  32.     Intr - Introduction.  A row that has been tagged with                  
  33.            this identifier will be printed only once, at the               
  34.            beginning of the report.  Multiple rows of this                 
  35.            type are accepted.                                              
  36.                                                                            
  37.     Head - Header.  This row type is printed at the top of                 
  38.            each report page.  If the report contains Intr rows,            
  39.            then the header rows will be printed below the                  
  40.            introduction rows on page one.  Multiple header rows            
  41.            are accepted.                                                   
  42.                                                                            
  43.     Body - Body.  A body row will be printed once for each                 
  44.            qualifying record in the database.  Multiple body               
  45.            rows are accepted.                                              
  46.                                                                            
  47.     Foot - Footer.  Footer rows are printed at the bottom of               
  48.            each report page.  Multiple footer rows are accepted.           
  49.                                                                            
  50.     Conc - Conclusion.  A row that has been tagged with this               
  51.            identifier will be printed only once, at the end of             
  52.            the report.  Conclusion rows are most often used to             
  53.            summarize data within the report.  Multiple rows of             
  54.            this type are accepted.                                         
  55.                                                                            
  56.    Break - A row that is to be printed only when the contents              
  57.            of a specified field changes will be identified in              
  58.            the when printed column by the name of the field.               
  59.                                                                            
  60.                                                                            
  61.                                                                            
  62. REPORT ELEMENTS                                                            
  63.                                                                            
  64.     Report elements consist of fields from the database (with or without   
  65. summary attributes assigned), free text and RGS supplied functions.        
  66.                                                                            
  67.     The following table displays the report element types that are allowed 
  68.  or disallowed for each row type in the report.  Note: If a report element 
  69. is used on a row type where it is not allowed, the RGS will consider it as 
  70. free text.                                                                 
  71.                                                                            
  72.  Type               Allowed                       Not Allowed              
  73. ------       ------------------------       ------------------------------ 
  74.  Intr        Free Text,@TIME,@DATE          Fields,@PAGENUM,@NEWPAGE,      
  75.                                             Fields with summary attributes 
  76.                                                                            
  77.  Head        Free Text,@TIME,@DATE,         Fields,@NEWPAGE                
  78.              @PAGENUM                                                      
  79.                                                                            
  80.  Body        Free Text,Fields,              @NEWPAGE,@PAGENUM              
  81.              Fields with summary                                           
  82.              attributes,@TIME,@DATE                                        
  83.                                                                            
  84.  Foot        Free Text,@TIME,@DATE,         @NEWPAGE                       
  85.              Fields with summary                                           
  86.              attributes,@PAGENUM                                           
  87.                                                                            
  88.  Conc        Free Text,@TIME,@DATE,         @PAGENUM                       
  89.              Fields with summary                                           
  90.              attributes,@NEWPAGE                                           
  91.                                                                            
  92.  Break       Free Text,Fields with          @TIME,@DATE,@PAGENUM,@NEWPAGE  
  93.              summary attributes                                            
  94.                                                                            
  95.                                                                            
  96.                                                                            
  97. USING REPORT ELEMENTS                                                      
  98.                                                                            
  99.     Free Text, as a report element, can be placed anywhere within the 66   
  100. row by 132 column boundaries.                                              
  101.                                                                            
  102.     The other report element types must be selected from a list of         
  103. available report elements.  To do this, move the small block cursor to the 
  104. location in the report design area that you wish to position the desired   
  105. report element and then press F10.  This opens a report element window that
  106. lists the four @ functions and the name of each field in the database.  Use
  107. the cursor control keys to move through the list to find the desired report
  108. element and then press Enter.  The report element will be placed into the  
  109. report design area.                                                        
  110.                                                                            
  111.     If the report element is a field name from the database, another window
  112. will automatically open displaying the attributes and display parameters   
  113. for this field.  If no changes are necessary, press Esc to close the window
  114. and continue designing your report.                                        
  115.                                                                            
  116.     To make changes to the attributes and parameters within the window,    
  117. move the reverse video cursor to the desired parameter and enter the new   
  118. value.  The attributes and display parameters for each field that is       
  119. displayed in the report are:                                               
  120.                                                                            
  121.      Summary - Normally used on Conc and Break                             
  122.                rows to summarize data within the report.                   
  123.                                                                            
  124.             NONE - This is the default for each field.                     
  125.                                                                            
  126.              SUM - The sum of all fields in the report                     
  127.                    by this name will be totaled.                           
  128.                                                                            
  129.            COUNT - The number of times that this field                     
  130.                    is printed will be displayed.                           
  131.                                                                            
  132.              AVG - The sum of all fields in the report                     
  133.                    by this name will be totaled and then                   
  134.                    the average displayed.                                  
  135.                                                                            
  136.              MIN - The minimum value printed in the report                 
  137.                    for this field will be displayed.                       
  138.                                                                            
  139.              MAX - The maximum value printed in the report                 
  140.                    for this field will be displayed.                       
  141.                                                                            
  142.      Justify - This parameter sets the field display position.             
  143.                                                                            
  144.                [Left      ] - Contents are left justified.                 
  145.                                                                            
  146.                [  Center  ] - Contents are centered.                       
  147.                                                                            
  148.                [     Right] - Contents are right justified.                
  149.                                                                            
  150.                Var - Left justified and variable length.                   
  151.                                                                            
  152.    On Change - The contents of this field will be printed only             
  153.                when the contents change.  You can select one of            
  154.                three parameters:                                           
  155.                                                                            
  156.                N - No, print the contents of this field for                
  157.                    each record in the database.                            
  158.                                                                            
  159.                Y - Yes, print the contents of this field only              
  160.                    when a change is detected.                              
  161.                                                                            
  162.                P - Yes, print the contents of this field only              
  163.                    when a change is detected, but, on a new page.          
  164.                                                                            
  165.       Length - This parameter sets the width of the displayed              
  166.                field.                                                      
  167.                                                                            
  168.     Decimals - For numeric field types, the number of decimal              
  169.                places can be set for the report display.                   
  170.                                                                            
  171.       Format - Sets the type of display for numeric fields.                
  172.                                                                            
  173.                                                                            
  174.     Four of the report elements are RGS functions that can be used to      
  175. enhance the presentation of the report. They are:                          
  176.                                                                            
  177.        @DATE - Displays the current system date.                           
  178.                                                                            
  179.        @TIME - Displays the current system time.  As the                   
  180.                report is printed, this value is updated.                   
  181.                                                                            
  182.    @PAGE NUM - Prints the current page number of the report.               
  183.                                                                            
  184.    @NEW PAGE - Advances the paper to the next top of form.                 
  185.                                                                            
  186.                                                                            
  187.                                                                            
  188. FILE COMMANDS                                                              
  189.                                                                            
  190.     F2 F U - Selects the database to be used for the report.               
  191.              This command should be executed when first entering           
  192.              the report generation system.  Many of the commands           
  193.              that will be used to design the report depend on              
  194.              data peculiar to a specific database.  This command           
  195.              links this report design session to the specified             
  196.              database so that the needed information can be                
  197.              obtained.                                                     
  198.                                                                            
  199.     F2 F L - Loads a Flexbase report format file.                          
  200.              Previously saved Flexbase report format files have            
  201.              the extension <filename>.FBR.  These format files             
  202.              can be loaded into the report design area using this          
  203.              command.                                                      
  204.                                                                            
  205.     F2 F S - Saves a report design to disk.                                
  206.              Sometimes you may want to print a report several              
  207.              times, but on different occassions.  This command             
  208.              allows you to save the current report design to               
  209.              a disc file.  It can be reloaded at at later date             
  210.              using the F2-F-L command.                                     
  211.                                                                            
  212.     F2 F Q - Quits this report generation session.                         
  213.              This command quits the current report design session          
  214.              and returns you to the DOS prompt.  If you want to            
  215.              save the current report design before quitting, use           
  216.              the F2-F-S command.                                           
  217.                                                                            
  218.                                                                            
  219.                                                                            
  220.                                                                            
  221. EDIT COMMANDS                                                              
  222.                                                                            
  223.     F2 E D - Delete the selected item.                                     
  224.              To delete an item, the row or report element must             
  225.              first be selected.  To select a row, move the small           
  226.              block cursor to the desired row and execute the               
  227.              F2-E-R command which will highlight the row.  Then            
  228.              use this command to remove the row from the report            
  229.              design.  Any free text or report elements on the row          
  230.              will be deleted.  Move the small block cursor to the          
  231.              desired report element and execute this command to            
  232.              remove the single element from the report design.             
  233.                                                                            
  234.     F2 E I - Insert a blank row at the current cursor position.            
  235.              All report elements and free text below this line             
  236.              will be moved down one row.  Any report design data           
  237.              on row 66 will be lost.                                       
  238.                                                                            
  239.     F2 E R - Select the current row.                                       
  240.              This command will highlight the selected row.  This           
  241.              row will remain as the selected item until it is              
  242.              moved, deleted, or another row is selected.                   
  243.                                                                            
  244.              Note: When deleting a selected item, a selected row           
  245.                    takes precedence over a selected report element.        
  246.                                                                            
  247.     F2 E M - Move the selected item.                                       
  248.              When executed, this command will reverse video the            
  249.              selected item so that you can easily follow it while          
  250.              it is being moved.  When the new position is located          
  251.              press Enter.  If the new position will not collide            
  252.              with free text or other report elements, the move             
  253.              will be allowed, otherwise, a beep will sound and             
  254.              you will be given the opportunity to reposition the           
  255.              selected item.  To cancel a move request, press Esc.          
  256.                                                                            
  257.     F2 E C - Clears the report design area.                                
  258.              This command erases the report design area and                
  259.              resets all tables.                                            
  260.                                                                            
  261.                                                                            
  262.                                                                            
  263. PRINT COMMANDS                                                             
  264.                                                                            
  265.     F2 P P - Print report using current parameters.                        
  266.              This command initiates the printing process.  The             
  267.              free text contents of the report design area, as              
  268.              well as the report elements and their associated              
  269.              attributes will be used to provide the desired                
  270.              report display.                                               
  271.                                                                            
  272.     F2 P D - Set output device parameters.                                 
  273.              This command displays an output device parameter              
  274.              table that lists the current output device, margins,          
  275.              page length and print font that will be used to               
  276.              format the report when printed.                               
  277.                                                                            
  278.              Note: A report that is printed to the screen will             
  279.              display columns 1 thru 80 of the report design area.          
  280.              Left and right margins will be disabled when printing         
  281.              to the screen.                                                
  282.                                                                            
  283.                                                                            
  284.                                                                            
  285. SEARCH COMMANDS                                                            
  286.                                                                            
  287.     F2 S C - Set conditions to qualify records.                            
  288.              This command allows you to enter conditions that              
  289.              must be met in order for the record to be included            
  290.              in the report display.  Conditions can be set for             
  291.              fields that may or may not be included in the final           
  292.              report display.                                               
  293.                                                                            
  294.     F2 S S - Set the sort order for the report.                            
  295.              This command displays a table of key fields that              
  296.              can be selected to order the report.  If multiple             
  297.              sorting is desired, or the report will be printed             
  298.              using multiple field breaks, the database should              
  299.              sorted using the FBS module.                                  
  300.                                                                            
  301.              Note: If the database has been sorted using the               
  302.              FBS module, leave the sort table blank or you will            
  303.              interrupt the disired sort order display.                     
  304.                                                                            
  305.                                                                            
  306.                                                                            
  307. WARNING!                                                                   
  308.                                                                            
  309.     If you do not have a printer connected to your computer, Flexbase will 
  310. notify you that the printer is not ready.  You will have to wait several   
  311. seconds for the DOS time out to occur before pressing the Esc key to cancel
  312. the print request.                                                         
  313.